home *** CD-ROM | disk | FTP | other *** search
/ BMUG Revelations / BMUG Revelations.toast / Utilities / System Utility / inTheFolder1.1.1. / Read Me < prev   
Text File  |  1993-10-05  |  11KB  |  344 lines

  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.  
  17.  
  18. * About 'inTheFolder'....
  19.  
  20.     inTheFolder is a utility program that lets you rename and/or change the creator of all files in a given folder. That's about all there is to it, except after writing the program and using it, I found it so useful that I wound up asking myself why I hadn't written it earlier.
  21. Since the release of inTheFolder v1.0b2 in May '92 as BeerWare, fifteen people have sent beer and one kind soul, for reasons unbeknownst to you or I, sent rice coupons. I also received numerous valuable comments and opinions via CompuServe (but no beer). Thanks to everyone. I love you all.
  22.  
  23.     Okay, time to begin explaining the menus and commands. Let's begin with the File Menu.
  24.  
  25.  
  26. a) FileMenu
  27. fig.1
  28.  
  29.  
  30.  
  31.  
  32.  
  33.  
  34.  
  35.  
  36.  
  37.  
  38.  
  39. a-1) New Spec
  40.     Creates a new 'specification'. Choosing this from the menu will bring up the spec sheet window, as shown below in fig. 2.
  41. fig. 2
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.     As you can see, the default setting for the program's action is 'rename'. You just fill in the spec sheet (I sound like some petty bureaucrat instructing you to fill out a form), click on the 'Do it now!!' button, and the object files are automatically renamed. Let's use an example to see how it works.
  63. Let's say we have a folder the same as the one shown below in fig. 3 (this happens to be the folder I used in developing this program...for what it's worth).
  64. fig. 3
  65.  
  66.  
  67.  
  68.  
  69.  
  70.  
  71.  
  72.  
  73.  
  74.  
  75.  
  76.  
  77.  
  78.  
  79. Let's try changing the names of all files ending in '.c' to '.k'. First we enter the following in the spec sheet we looked at earlier.
  80. fig. 4
  81.  
  82.  
  83.  
  84.  
  85.  
  86.  
  87. The 'Object File Type:' entry found below this on the spec sheet does not have much to do with our discussion at this stage (after all, all the files whose names end in '.c' happen to be text files anyway). It's easy to just leave it set to the default 'All Files', but let's go ahead and look at the popup menu.
  88.  
  89. fig. 5
  90.  
  91.  
  92.  
  93.  
  94.  
  95.  
  96.  
  97.     You can choose the type of file from this menu, or you can enter a file type for the object files using your keyboard. Macintosh file types are represented by a 4-byte ID (they are NOT 4-letter words!) And, as I will explain later, you can also add your most often used file types to this menu.
  98.  
  99.     Looking below the 'Folder:' label in the spec sheet window, you will see the full path name of the folder currently selected as the object folder for inTheFolder to act on. There is no need to change this for the example I have chosen (basically, when a New Spec file is opened, the object folder selected is the folder in which the inTheFolder program resided when it was double-clicked.) If you wish to change the folder that will be the object of inTheFolder's action, click on the 'Change Folder...' button. Doing so will bring up the oh-so familiar dialog box used for selecting between folders and files on your drive, shown in fig. 6 below (well it's been modified a little). Now select the object folder of your choice.
  100. fig. 6
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.     Now that we are ready, let's try clicking on the 'Do it now!!' button. I considered displaying an indicator that gave feedback along the lines of "we've done this much of the job so far!", but the whole process ends so quickly, I gave up the idea. In the end, I programmed it such that only the results of the action are displayed, as shown below in fig. 7 (and this can be turned off).
  118.  
  119. fig. 7
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.     Looking again at the folder we used for this example (fig. 8), you can see the results of the 'rename' action on the files in this folder.
  130. fig. 8
  131.  
  132.  
  133.  
  134.  
  135.  
  136.  
  137.  
  138.  
  139.  
  140.  
  141.  
  142.  
  143.  
  144.  
  145.  
  146.     Since V1.1, I've added a feature that is a somthing link a 'wildcard'. Please refer fig. 2 again. Filename textbox has '<oldname>' at initial. Before V1.1, this box must be specified, so you could not add some prefix or suffix without change of source file name. Now you can do it using this '<oldname>' keyword.
  147.  For exsample,
  148.    Pattern to find...: [<oldname>]
  149.    Replace with...: [copy of <oldname>]
  150.  This specification will add 'copy of ' prefix to source file name.
  151.  One more feature, 
  152.    Pattern to find...: [<oldname>]
  153.    Replace with...: [<Newname>]   <--- change the first character of filename to upper case.
  154.    Replace with...: [<NEWNAME>]   <--- change the all characters of filename to upper case.
  155.    Replace with...: [<newname>]   <--- change the all characters of filename to lower case.
  156.  
  157.     Now let's try making a spec sheet for changing the creator of a group of files. Click on the upper of the two radio buttons shown in fig. 2 (above), thereby selecting the 'Change creators in the folder' action. The spec sheet will change, as shown in fig. 9.
  158.  
  159. fig. 9
  160.  
  161.  
  162.  
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.     You will notice that what differs from the rename spec sheet is that you now enter the creator type you wish to change in the 'Creator to find...' and 'Change to...' boxes. As with the file type, this is a 4-byte ID. A number of commonly used creator types are already available in the popup menus on the right of each box; the popup menu looks something like fig. 10 below. As with the 'Object File Type' popup menu explained earlier, you can modify the contents of this popup menu (the explanation will follow later).
  180. fig. 10
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195. a-2) Open Spec...
  196.     Well, we have finally reached the second menu choice. But, having covered most of the functions of the program already, we should be able to plow through the rest in a breeze.
  197.     Since you are able to save a 'specification' file (I have named this the 'spec file' for convenience), the 'Open Spec...' menu choice lets you open spec files you have previously saved. inTheFolder is programmed to let you open up to a maximum of 10 spec files at once, but things become very confusing if too many files are open at once. I recommend opening two or three files unless you are blessed with an extremely large monitor.
  198.  
  199. a-3) Close Spec
  200.     This closes the spec file whose window is active (closest to the front when more than one spec file is open). If the file you are attempting to close originates from a 'New Spec', or if you have made any changes to the file since opening it, a dialog box will appear asking you to confirm whether you wish to save the file (fig. 11).
  201.  
  202. fig. 11
  203.  
  204.  
  205.  
  206.  
  207.  
  208.  
  209.  
  210.  
  211.  
  212. a-4) Save Spec
  213.     This menu choice saves the spec file whose window is active. This menu choice is not available if you have not made any changes since opening the file.
  214.  
  215. a-5) Save As...
  216.     This menu choice saves the spec file whose window is active in the location and name of your choice.
  217.  
  218. 4-6) Revert Spec...
  219.     Reverts  the spec file whose window is active to what it was the last time you saved it. This menu choice creates the opportunity to lose work you have done on a spec file, so I have programmed inTheFolder to display the following confirmation dialog box (fig. 12).
  220.  
  221. fig. 12
  222.  
  223.  
  224.  
  225.  
  226.  
  227.  
  228.  
  229.  
  230.  
  231. a-7) Quit
  232.     Quits inTheFolder. The dialog box shown in fig. 11 appears if any open windows have not been saved yet, confirming you have saved your work.
  233.  
  234.  
  235. b) Edit Menu
  236. fig. 13
  237.  
  238.  
  239.  
  240.  
  241.  
  242.  
  243.  
  244.  
  245.  
  246.     There is nothing special to explain about the Edit Menu. You can use its familiar functions to cut, copy, and paste when entering text. I didn't support 'Undo' because it was a pain in the neck.
  247.  
  248. c) Preferences Menu
  249. fig. 14
  250.  
  251.  
  252.  
  253.  
  254.  
  255. c-1) General...
  256.     You can set whether the 'Rename' or 'Change Creator' action will be the default when creating a spec sheet using 'New Spec...', and whether the results will be displayed after an action is completed (fig. 15).
  257. fig. 15
  258.  
  259.  
  260.  
  261.  
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268.  
  269.  
  270.  
  271. c-2) Object Files...
  272.     Lets you edit the contents of the 'Object Files' popup menu found on  the spec sheet window (fig. 16). The two items that cannot be edited are the 'All Files' and 'All Files and Folders' items.  Note that the items you add to the popup menu must begin with a 4 letter file type ID. The reason for this is simple; inTheFolder uses this file type to do its thing.
  273. fig. 16
  274.  
  275.  
  276.  
  277.  
  278.  
  279.  
  280.  
  281.  
  282.  
  283.  
  284.  
  285.  
  286.  
  287.  
  288. c-3) Creator Types...
  289.     Lets you change the 'Creator Type' popup menu found on the spec sheet window when using the spec sheet for the 'Change Creator' action. Editing is done in the same manner as explained for editing the object files in c-2 above. Here as well, each name must begin with a 4 letter ID (fig. 17).
  290. fig. 17
  291.  
  292.  
  293.  
  294.  
  295.  
  296.  
  297.  
  298.  
  299.  
  300.  
  301.  
  302.  
  303.  
  304.  
  305. * Wish & Tips
  306.  
  307.     Although this is a small program, it is AppleEvent aware. I began this planning to practice up on writing an AppleEvent aware program, but in the process I found myself no longer interested in supporting system 6.0.7 or earlier. Or maybe it was just a pain in the neck to do the work...I beg your understanding, and recommend you use this with system 7.0 or later.
  308.     And, now that the user can save their spec sheet as a file, I considered how to let you use the spec sheet with 'one touch'. If you double click on the spec sheet file while holding down the option key, inTheFolder will do its thing. You also can achieve the same thing by dragging a saved spec sheet file over inTheFolder's application icon (known as drag & drop). If you set the results to not be displayed in the 'General...' preference setting under the Preferences menu (i.e., the 'Display Results' checkbox is NOT checked), inTheFolder will automatically do its thing and then terminate (quit) by itself. Please try out this feature.
  309.  
  310. ** Fixed BUGs at V1.1
  311.  1. Crash if you open spec sheet that contains folder you have deleted.
  312.  2. When you specify 'Object Files' using keyboard (Not selecting from pop-up menu), it was ignored.
  313.  
  314. ** Fixed BUG at V1.1.1
  315.   V1.1 had caused crash at openning new specification file on SE/30 and IIx. It was fixed on V1.1.1.
  316.  
  317. *** In Closing...
  318.     inTheFolder is a BeerWare program. I am  still a beer aficionado, and tend consume at least a couple of large bottles a day to sustain myself. This message also appears in the program's 'About...' dialog box, but if you like inTheFolder and plan to use it, and if it is possible, please send me beer or anything that can be converted into beer (cash, gold, beer coupons, hops & barley...I leave it to your discretion). You are under no obligation to do this, but I consider it little to ask in return for the time and labour that I put into creating inTheFolder. For those who are interested, I won't expect beer from those who send me bug reports, suggestions, or comments concerning inTheFolder.
  319.  
  320.  
  321. Send my BEER to:
  322.  
  323. Hiroyuki Fujimoto
  324. 4-2-11-2A Shimomeguro,
  325. Meguro, Tokyo 153
  326. Japan
  327.  
  328.  
  329. Please send any comments, suggestions for further enhancements, or bug reports to me via electronic mail at any of the following addresses:
  330.  
  331. NiftyServe:    PGB00074
  332. CompuServe:    74610,74
  333. Asahi-Net:    XX5H-FJMT
  334.  
  335.  
  336.     One last note is to state that I hold all rights to inTheFolder. It is forbidden to sell it or use it as promotional material (bundle it with other products, give it out to subscribers as a bonus, etc.) without my written permission. It is also forbidden to distribute it via electronic mail, or list it in books or magazines without first contacting me.
  337.  
  338.     I also wish to thank my friend Alan Kastner for his assistance in translating this document into English. There's nothing better than having friends! (especially if they don't drink all my beer!)
  339.  
  340. Copyright (c) Hiro Fujimoto, 1992-1993 All rights reserved.
  341.  
  342. Apple and Macintosh are trademarks of Apple Computer, Inc.
  343.  
  344.